improvement(external-endpoints): v2 versions with clean signatures + updated docs based on openapi spec by icecrasher321 · Pull Request #5273 · simstudioai/sim

icecrasher321 · 2026-06-29T22:21:29Z

Summary

Introduces a parallel /api/v2 external API with consistent authentication, response envelopes, pagination, errors, and resource semantics. Existing v1 wire behavior remains available; breaking cleanup and the expanded resource model live in v2.

The v2 OpenAPI reference is now generated from the shared Zod route contracts. Schema descriptions, examples, formats, bounds, nullability, and requiredness stay next to the runtime validation they document, eliminating the hand-maintained spec drift that previously existed.

Highlights

Adds and expands v2 APIs for workflows and runs, files and signed uploads, tables, knowledge bases, logs, billing, folders, credentials, MCP servers, skills, and custom tools.
Completes workflow CRUD, version, execution, status, cancellation, resume, filtering, sorting, and pagination surfaces.
Adds file metadata with share status plus explicit share and unshare operations.
Adds ownerEmail to knowledge-base and table metadata and rejects unsupported table required input.
Centralizes protected operations behind shared Principal/application use cases across public APIs, internal APIs, and Copilot adapters.
Returns access denied when a caller can see a resource but lacks mutation permission, while continuing to hide resources they cannot see.
Persists signed multipart upload sessions and unifies file and knowledge-document upload lifecycles.
Generates and validates seven OpenAPI documents covering 128 operations directly from the contracts.
Updates the API reference and CI drift checks around the generated specifications.
Integrates the latest staging changes; the upload-session migration is sequenced as 0289 after staging's 0287 and 0288 migrations.

Compatibility and rollout

v1 endpoints remain available and retain their existing wire contracts.
The v2 surface is gated behind the shared v2 API feature flag.
Database changes are additive and backward-compatible with the deployed application version.

Verification

bun run check:api-validation:strict
bun run check:openapi
bun run check:migrations
env NODE_OPTIONS=--max-old-space-size=8192 bun run type-check in apps/sim
215 focused API, authorization, knowledge, table, folder, and provenance tests
bun run test in packages/audit
bun run type-check in packages/testing
helm lint helm/sim --values helm/sim/ci/default-values.yaml
bun run scripts/check-cron-parity.ts

Checklist

Code follows project style guidelines
Self-reviewed the conflict resolutions and generated migration chain
Tests added or updated and passing
Generated OpenAPI output is current and contract-validated
No new API-boundary validation drift
I confirm that I have read and agree to the terms outlined in the Contributor License Agreement

…ership workflow edits via sockets, ui improvements

…hog upgrade

…lama fix

…ng improvements, posthog, secrets mutations

…ration, signup method feature flags, SSO improvements

* feat(posthog): Add tracking on mothership abort (#4023) Co-authored-by: Theodore Li <theo@sim.ai> * fix(login): fix captcha headers for manual login (#4025) * fix(signup): fix turnstile key loading * fix(login): fix captcha header passing * Catch user already exists, remove login form captcha

…nts, secrets performance, polling refactors, drag resources in mothership

… enterprises

…ension

…y invalidation, HITL docs

…endar triggers, docs updates, integrations/models pages improvements

…ups ui

…ions, jira forms endpoints

…mat, logs performance improvements fix(csp): add missing analytics domains, remove unsafe-eval, fix workspace CSP gap (#4179) fix(landing): return 404 for invalid dynamic route slugs (#4182) improvement(seo): optimize sitemaps, robots.txt, and core web vitals across sim and docs (#4170) fix(gemini): support structured output with tools on Gemini 3 models (#4184) feat(brightdata): add Bright Data integration with 8 tools (#4183) fix(mothership): fix superagent credentials (#4185) fix(logs): close sidebar when selected log disappears from filtered list; cleanup (#4186)

v0.6.46: mothership streaming fixes, brightdata integration

…m integration, atlassian triggers

* refactor: enforce copilot table application boundary * fix(tables): finish application boundary migration * fix(tables): restore scoped copilot imports * fix(tables): compose copilot commands atomically * fix(tables): preserve workflow group scheduling * fix(tables): complete fixed copilot composition * fix(tables): reject enrichment output mutation * fix(tables): complete authorized application boundary

* fix(workflows): migrate Copilot application boundary * fix(workflows): finish delegated application migration * fix(workflows): encode VFS folder aliases * fix(workflows): close application composition gaps * fix(workflows): preserve VFS validation errors * fix(workflows): complete application boundary migration * test(workflows): format canonical binding coverage * fix(workflows): scope executor metadata reads * fix(workflows): bind executor metadata targets

# Conflicts: # apps/sim/app/api/knowledge/search/route.ts # apps/sim/lib/copilot/request/tools/tables.test.ts

# Conflicts: # apps/sim/app/api/mcp/serve/[serverId]/route.ts # apps/sim/lib/copilot/tools/handlers/workflow/mutations.ts

* feat(api): generate v2 OpenAPI from contracts * fix(api): preserve string boolean wire defaults * fix(api): document file download headers * fix(docs): use TypeScript CLI with Next.js * fix(docs): avoid client-rendered theme script * fix(api): document departed audit default * feat(api): replace legacy core docs with v2 * feat(api): generate v2 OpenAPI from contracts * feat(api): refine generated v2 OpenAPI docs * fix(docs): align localized v2 execution examples

waleedlatif1 and others added 30 commits April 3, 2026 23:30

v0.6.23: MCP fixes, remove local state in favor of server state, moth…

0b9019d

…ership workflow edits via sockets, ui improvements

v0.6.24: copilot feedback wiring, captcha fixes

a54dcbe

v0.6.25: cloudwatch, cloudformation, live kb sync, linear fixes, post…

28af223

…hog upgrade

v0.6.26: ui improvements, multiple response blocks, docx previews, ol…

d889f32

…lama fix

v0.6.27: new triggers, mothership improvements, files archive, queuei…

316bc8c

…ng improvements, posthog, secrets mutations

v0.6.28: new docs, delete confirmation standardization, dagster integ…

3f508e4

…ration, signup method feature flags, SSO improvements

v0.6.30: slack trigger enhancements, connectors performance improveme…

d7da35b

…nts, secrets performance, polling refactors, drag resources in mothership

v0.6.31: elevenlabs voice, trigger.dev fixes, cloud whitelabeling for…

cf233bb

… enterprises

v0.6.32: BYOK fixes, ui improvements, cloudwatch tools, jsm tools ext…

f8f3758

…ension

v0.6.33: polling improvements, jsm forms tools, credentials reactquer…

3c8bb40

…y invalidation, HITL docs

v0.6.34: trigger.dev fixes, CI speedup, atlassian error extractor

d33acf4

v0.6.35: additional jira fields, HITL docs, logs cleanup efficiency

4f40c4c

v0.6.36: new chunkers, sockets state machine, google sheets/drive/cal…

cbfab1c

…endar triggers, docs updates, integrations/models pages improvements

v0.6.37: audit logs page, isolated-vm worker rotation, permission gro…

4309d06

…ups ui

v0.6.38: models page

8b57476

v0.6.39: billing fixes, tools audit, landing fix

e3d0e74

v0.6.40: mothership tool loop, new skills, agiloft, STS, IAM integrat…

0ac0539

…ions, jira forms endpoints

v0.6.41: webhooks fix, workers removal

3838b6e

v0.6.42: mothership nested file reads, search modal improvements

fc07922

v0.6.43: mothership billing idempotency, env var resolution fixes

3a1b1a8

v0.6.44: streamdown, mothership intelligence, excel extension

46ffc49

Merge pull request #4190 from simstudioai/staging

c0bc62c

v0.6.46: mothership streaming fixes, brightdata integration

v0.6.46: mothership queueing, web vitals

387cc97

v0.6.47: files focusing, documentation, opus 4.7

2dbc7fd

v0.6.48: import csv into tables, subflow fixes, CSP updates

8a50f18

v0.6.49: deploy sockets event, resolver, logs improvements, monday.co…

dcf3302

…m integration, atlassian triggers

v0.6.50: ppt/doc/pdf worker isolation, docs, chat, sidebar improvements

bc09865

v0.6.51: tables improvements, billing fixes, 404 pages, code hygiene

5f56e46

vercel Bot temporarily deployed to Preview August 10, 2026 05:09 Inactive

vercel Bot temporarily deployed to Preview August 10, 2026 05:18 Inactive

vercel Bot temporarily deployed to Preview August 10, 2026 06:23 Inactive

TheodoreSpeaks added 3 commits August 10, 2026 10:42

chore(api): integrate staging into v2 endpoints

24ff8f8

chore(api): merge latest staging updates

6b336a8

# Conflicts: # apps/sim/app/api/knowledge/search/route.ts # apps/sim/lib/copilot/request/tools/tables.test.ts

chore(api): merge latest provenance update

96ecfe0

# Conflicts: # apps/sim/app/api/mcp/serve/[serverId]/route.ts # apps/sim/lib/copilot/tools/handlers/workflow/mutations.ts

vercel Bot deployed to Preview August 10, 2026 18:53 View deployment

Base automatically changed from staging to main August 11, 2026 00:33

vercel Bot deployed to Preview August 11, 2026 05:02 View deployment

improvement(skills): align application operation guidance (#6532)

3b11f09

TheodoreSpeaks force-pushed the improvement/v2-endpoints branch from 075b1cd to 3b11f09 Compare August 11, 2026 06:28

vercel Bot deployed to Preview August 11, 2026 06:34 View deployment

feat(api): expose v2 resource owners

1c7e4e1

vercel Bot deployed to Preview August 11, 2026 07:24 View deployment

fix(api): distinguish visible resource authorization failures (#6537)

da3442e

vercel Bot temporarily deployed to Preview August 11, 2026 08:29 Inactive

TheodoreSpeaks changed the base branch from main to staging August 11, 2026 08:38

vercel Bot deployed to Preview August 11, 2026 08:42 View deployment

Merge origin/staging into improvement/v2-endpoints

398d17c

vercel Bot deployed to Preview August 11, 2026 09:03 View deployment

fix(ci): restore Helm diff and sync audit mock

7f383d0

vercel Bot deployed to Preview August 11, 2026 09:12 View deployment

fix CI regressions after staging merge

28628b2

vercel Bot temporarily deployed to Preview August 11, 2026 09:36 Inactive

TheodoreSpeaks merged commit 263e3ca into staging Aug 11, 2026
28 checks passed

This was referenced Aug 11, 2026

v0.8.0: new workflow UI, cli, v2 API, salesforce JWT, provenance improvements, incidentio tools, block retries #6533

Open

fix(v2-api): standardization #6542

Open

Navigation Menu

Uh oh!

improvement(external-endpoints): v2 versions with clean signatures + updated docs based on openapi spec - #5273

improvement(external-endpoints): v2 versions with clean signatures + updated docs based on openapi spec#5273
TheodoreSpeaks merged 221 commits into
stagingfrom
improvement/v2-endpoints

icecrasher321 commented Jun 29, 2026 •

edited by TheodoreSpeaks

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

icecrasher321 commented Jun 29, 2026 • edited by TheodoreSpeaks Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Highlights

Compatibility and rollout

Verification

Checklist

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

icecrasher321 commented Jun 29, 2026 •

edited by TheodoreSpeaks

Loading